Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add installation guide #818

Merged
merged 84 commits into from
Nov 14, 2022
Merged

docs: add installation guide #818

merged 84 commits into from
Nov 14, 2022

Conversation

Florence-Njeri
Copy link
Collaborator

Description
This is the ag CLI installation and upgrade guide.

Related issue(s)
Fixes #810

@Florence-Njeri Florence-Njeri changed the title docs: Installation guide docs: installation guide Aug 19, 2022
@Florence-Njeri Florence-Njeri marked this pull request as draft August 19, 2022 05:41
@Florence-Njeri Florence-Njeri marked this pull request as ready for review August 29, 2022 14:25
@Florence-Njeri Florence-Njeri marked this pull request as draft August 30, 2022 07:39
Copy link
Member

@derberg derberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Florence-Njeri

We are missing some content here.

So the thing is that there are 2 ways (actually 3 😄 ) to install AsyncAPI generator

  • generator is a library that anyone can also use in their Nodejs applications. Like we do in our server-api -> https://github.com/asyncapi/server-api/blob/master/package.json#L49
    So you use it as library, not its CLI. You install it like npm install @asyncapi/generator, not with -g flag, as you do not install it globally but only inside your project. Sample code -> https://github.com/asyncapi/server-api/blob/master/src/services/generator.service.ts#L18-L29. **We need this covered in this document too, I mean info that it is a library and how to install in a project (same npm and nodejs restrictions)
  • generator also contains cli. Atm PR to introduce generator in @asyncapi/cli is still not merged. So I suggest, for now, forget about it. Do not mention how to install @asyncapi/cli (also remove MacOS instructions as they are valid only for AsyncAPI CLI, not generator CLI). So focus only on @asyncapi/generator please

(actually 3 😄 )

it would be nifty to mention that if someone wants to use Generator CLI in CI/CD to automate generation (many people do it), then whey should just install generator CLI in their CI/CD, but in case of GitHub Actions, they can use https://github.com/marketplace/actions/generator-for-asyncapi-documents


I hope I'm not confusing, please lemme know if you need more help

docs/installation-guide.md Outdated Show resolved Hide resolved
@Florence-Njeri Florence-Njeri marked this pull request as ready for review September 8, 2022 17:22
Copy link
Member

@derberg derberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

few minors

also please add these new docs here https://github.com/asyncapi/generator/blob/master/docs/README.md

After Intro, and 2nd and 3rd doc

README.md Outdated Show resolved Hide resolved
docs/installation-guide.md Show resolved Hide resolved
derberg
derberg previously approved these changes Oct 25, 2022
Copy link
Member

@derberg derberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🚀
@alequetzalli wanna have a final look before I merge?

@derberg derberg changed the title docs: installation guide docs: add installation guide Nov 8, 2022
docs/installation-guide.md Outdated Show resolved Hide resolved
Co-authored-by: Lukasz Gornicki <lpgornicki@gmail.com>
derberg
derberg previously approved these changes Nov 8, 2022
Copy link
Member

@derberg derberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm 🚀

@alequetzalli wanna approve before merge?

quetzalliwrites
quetzalliwrites previously approved these changes Nov 9, 2022
Copy link
Member

@quetzalliwrites quetzalliwrites left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MERGING TIME BABY 🚢 🚢 🚢 🚢 🚢 🚢

@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@derberg
Copy link
Member

derberg commented Nov 14, 2022

/rtm

@asyncapi-bot asyncapi-bot merged commit 6bb824d into asyncapi:master Nov 14, 2022
@asyncapi-bot
Copy link
Contributor

🎉 This PR is included in version 1.9.14 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants